home *** CD-ROM | disk | FTP | other *** search
/ Aminet 15 / Aminet 15 - Nov 1996.iso / Aminet / util / cli / DoVer.lha / DoVer / DoVer.doc < prev    next >
Text File  |  1996-09-28  |  4KB  |  116 lines
  1.  
  2.     $VER: DoVer V1.6 (28.09.96)
  3.           =====================
  4.  
  5. Introducing
  6.   DoVer searchs version strings ("$VER...") in files. Optional the version
  7.   string will written to the file comment.
  8.   If xfd.library is available files will unpacked before scanned.
  9.   If xfd.library is available executable files without a "$VER" will
  10.   relocated and scanned for a resident structure ($4AFC), this will find
  11.   the version of libraries, devices and handlers.
  12.   
  13.   The idea of copying the version string to the file-comment is not from me,
  14.   but from Drago Fiser's tool v2c (aminet:util/cli/v2c.lha), thanks to you !
  15.   
  16.   
  17. Requirements
  18.   Kickstart 2.0 (V37) or better
  19.   
  20.  
  21. Disclaimer
  22.   This software is subject to the "Standard Amiga FD-Software Copyright Note"
  23.   It is Freeware as defined in paragraph 4a.
  24.   For more information please read "AFD-COPYRIGHT" (Version 1 or higher).
  25.  
  26.  
  27. Installation
  28.   just copy DoVer anywhere you like (e.g. C:)
  29.   for decrunching and relocating the xfd-package must be installed
  30.   (currently aminet:util/pack/xfd115.lha)
  31.  
  32.  
  33. Using
  34.   - open a Shell and type in "DoVer <name_of_file>"
  35.     DoVer will load the file and output the version string if found
  36.   - DoVer is PURE and can made resident
  37.   - see CLI-Convention for further details
  38.  
  39.  
  40. The CLI-Convention
  41.   - Template :
  42.     DoVer    FILE/A/M,FMT/K,DEFAULT/K,FORCE/S,APPEND/S,PREPEND/S,
  43.         QUIET/S,NOCOMM/S
  44.  
  45.     FILE/A/M    the name of the files to search in
  46.             (you can specify multiple files !)
  47.     
  48.     FMT/K        with this you can create your own version format
  49.             specify a format string using these special keys:
  50.                 %n - program name (first word in $VER)
  51.                 %v - version (second word in $VER)
  52.                 %d - day of the datestamp (1..31)
  53.                 %m - month as number (1..12)
  54.                 %M - month as string (Jan..Dec)
  55.                 %y - year as short number (0..99)
  56.                 %Y - year as long number (1978..2077)
  57.                 %e - extra (all after the date)
  58.                 %% - to get a '%'
  59.             between the "%" and the keychar you can insert an
  60.             integer which sets the minimal length of the inserted
  61.             field in the version string (fillchar is SPACE)
  62.             if DoVer cannot convert the $VER the format will
  63.             ignored and the unmodified $VER is written
  64.     Examples:
  65.     orginal version string = "DoVer 1.6 (28.09.96) by B.Jahn"
  66.     FMT="%n %v (%d.%m.%y)"        -> "DoVer 1.6 (28.9.96)"
  67.     FMT="Version %v at %d.%M.%Y"    -> "Version 1.6 at 28.Sep.1996"
  68.     FMT="%5v (%2d %M%3y) %n %e"    -> "  1.6 (28 Sep 96) DoVer by B.Jahn"
  69.     
  70.     DEFAULT/K    if no version will found this is the default
  71.             string for SetComment
  72.  
  73.     FORCE/S        overwrite exist comment
  74.     
  75.     APPEND/S    the version will appended on exist comment
  76.     
  77.     PREPEND/S    the version will inserted in front of exist comment
  78.     
  79.     QUIET/S        make no output except error messages
  80.     
  81.     NOCOMM/S    set not the comment
  82.     
  83.     the keyword SHORT is removed starting at version 1.5 use FMT/K instead
  84.     the keyword CONVERDATE is removed starting at version 1.5 use FMT/K instead
  85.     only one of FORCE,APPEND,PREPEND can specified at the same time
  86.  
  87.   - My personal use in DOpus (4.12) :
  88.     "DoVer write"
  89.     C:DoVer FMT="%5v (%2d %M %y) %n" DEFAULT="    -" FORCE QUIET {O}
  90.     (Options: "CD source" "Do all files" "Reload each file")
  91.     "DoVer show"
  92.     C:DoVer NOCOMM {O}
  93.     (Options: "CD source" "Do all files" "Output window")
  94.  
  95.  
  96. Bugs
  97.   - version strings larger than 255 chars will cut for display
  98.     the string for the comment will cut to 79 chars
  99.  
  100.  
  101. Thanks to
  102.   Bill Boegelein, Rudolph Riedel, Tobias Haase for suggestions and comments
  103.  
  104.  
  105. Contact me for bugs, improvements, comments ...
  106.  
  107. EMail:    jah@boss.hrz.fh-zwickau.de
  108. WWW:    http://www.th-zwickau.de/~jah/
  109. Mail:    Bert Jahn
  110.     WE 9321
  111.     Otto-Hahn-Straße 14
  112.     Zwickau
  113.     08066
  114.     Germany
  115.  
  116.